API docs by Redocly

Service for namespace resin

Download OpenAPI specification:Download

This service is located at https://127.0.0.1/v6/

actor

Delete entity from actor

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

api_key

Get entities from api_key

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "key" "key desc" "expiry_date" "expiry_date desc" "name" "name desc" "description" "description desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "key" "expiry_date" "name" "description"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__actor"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from api_key by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "key" "expiry_date" "name" "description"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__actor"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "key": "string",
  • "expiry_date": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "description": "string",
  • "is_of__actor": {
    }
}

Update entity in api_key

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

key
string
expiry_date
string or null <date-time>
name
string or null
description
string or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "expiry_date": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from api_key

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related is_of__actor

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42"
}

application

Get entities from application

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "actor" "actor desc" "should_track_latest_release" "should_track_latest_release desc" "is_of__class" "is_of__class desc" "app_name" "app_name desc" "slug" "slug desc" "is_host" "is_host desc" "is_archived" "is_archived desc" "uuid" "uuid desc" "is_public" "is_public desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to application

Request Body schema: application/json

New entity

required
integer or string <int64>
integer or string <int64>
should_track_latest_release
boolean
is_of__class
string
app_name
string
slug
string
is_host
boolean
is_archived
boolean
uuid
string
is_public
boolean
object (entityReference)
object (entityReference)
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {},
  • "is_for__device_type": {},
  • "application_type": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

Get entity from application by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

Update entity in application

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

integer or string <int64>
should_track_latest_release
boolean
is_of__class
string
app_name
string
slug
string
is_host
boolean
is_archived
boolean
uuid
string
is_public
boolean

Responses

Request samples

Content type
application/json
{
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from application

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related organization

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "name" "handle"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "name": "string",
  • "handle": "string"
}

Get related is_for__device_type

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name" "logo" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__cpu_architecture" "belongs_to__device_family"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string",
  • "name": "string",
  • "logo": "string",
  • "contract": "string",
  • "is_of__cpu_architecture": {
    },
  • "belongs_to__device_family": {
    }
}

Get related should_be_running__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

Get related depends_on__application

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

Get related application_type

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "name" "supports_web_url" "supports_multicontainer" "supports_gateway_mode" "needs__os_version_range" "requires_payment" "is_legacy" "slug" "description" "maximum_device_count"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "name": "string",
  • "supports_web_url": true,
  • "supports_multicontainer": true,
  • "supports_gateway_mode": true,
  • "needs__os_version_range": "string",
  • "requires_payment": true,
  • "is_legacy": true,
  • "slug": "string",
  • "description": "string",
  • "maximum_device_count": 0
}

application_config_variable

Get entities from application_config_variable

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "name" "name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to application_config_variable

Request Body schema: application/json

New entity

name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "application": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "application": {
    }
}

Get entity from application_config_variable by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "application": {
    }
}

Update entity in application_config_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from application_config_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related application

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

application_environment_variable

Get entities from application_environment_variable

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "name" "name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to application_environment_variable

Request Body schema: application/json

New entity

name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "application": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "application": {
    }
}

Get entity from application_environment_variable by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "application": {
    }
}

Update entity in application_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from application_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related application

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

application_tag

Get entities from application_tag

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "tag_key" "tag_key desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "tag_key" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to application_tag

Request Body schema: application/json

New entity

tag_key
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "tag_key": "string",
  • "id": "42",
  • "value": "string",
  • "application": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "tag_key": "string",
  • "id": "42",
  • "value": "string",
  • "application": {
    }
}

Get entity from application_tag by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "tag_key" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "tag_key": "string",
  • "id": "42",
  • "value": "string",
  • "application": {
    }
}

Update entity in application_tag

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

tag_key
string
value
string

Responses

Request samples

Content type
application/json
{
  • "tag_key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from application_tag

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related application

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

application_type

Get entities from application_type

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "name" "name desc" "supports_web_url" "supports_web_url desc" "supports_multicontainer" "supports_multicontainer desc" "supports_gateway_mode" "supports_gateway_mode desc" "needs__os_version_range" "needs__os_version_range desc" "requires_payment" "requires_payment desc" "is_legacy" "is_legacy desc" "slug" "slug desc" "description" "description desc" "maximum_device_count" "maximum_device_count desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "name" "supports_web_url" "supports_multicontainer" "supports_gateway_mode" "needs__os_version_range" "requires_payment" "is_legacy" "slug" "description" "maximum_device_count"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to application_type

Request Body schema: application/json

New entity

required
integer or string <int64>
name
string
supports_web_url
boolean
supports_multicontainer
boolean
supports_gateway_mode
boolean
needs__os_version_range
string or null
requires_payment
boolean
is_legacy
boolean
slug
string
description
string or null
maximum_device_count
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "id": "42",
  • "name": "string",
  • "supports_web_url": true,
  • "supports_multicontainer": true,
  • "supports_gateway_mode": true,
  • "needs__os_version_range": "string",
  • "requires_payment": true,
  • "is_legacy": true,
  • "slug": "string",
  • "description": "string",
  • "maximum_device_count": 0
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "name": "string",
  • "supports_web_url": true,
  • "supports_multicontainer": true,
  • "supports_gateway_mode": true,
  • "needs__os_version_range": "string",
  • "requires_payment": true,
  • "is_legacy": true,
  • "slug": "string",
  • "description": "string",
  • "maximum_device_count": 0
}

Get entity from application_type by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "name" "supports_web_url" "supports_multicontainer" "supports_gateway_mode" "needs__os_version_range" "requires_payment" "is_legacy" "slug" "description" "maximum_device_count"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "name": "string",
  • "supports_web_url": true,
  • "supports_multicontainer": true,
  • "supports_gateway_mode": true,
  • "needs__os_version_range": "string",
  • "requires_payment": true,
  • "is_legacy": true,
  • "slug": "string",
  • "description": "string",
  • "maximum_device_count": 0
}

Update entity in application_type

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

name
string
supports_web_url
boolean
supports_multicontainer
boolean
supports_gateway_mode
boolean
needs__os_version_range
string or null
requires_payment
boolean
is_legacy
boolean
slug
string
description
string or null
maximum_device_count
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "supports_web_url": true,
  • "supports_multicontainer": true,
  • "supports_gateway_mode": true,
  • "needs__os_version_range": "string",
  • "requires_payment": true,
  • "is_legacy": true,
  • "slug": "string",
  • "description": "string",
  • "maximum_device_count": 0
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from application_type

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

cpu_architecture

Get entities from cpu_architecture

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "slug" "slug desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from cpu_architecture by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string"
}

device

Get entities from device

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "actor" "actor desc" "api_heartbeat_state" "api_heartbeat_state desc" "uuid" "uuid desc" "local_id" "local_id desc" "device_name" "device_name desc" "note" "note desc" "is_online" "is_online desc" "last_connectivity_event" "last_connectivity_event desc" "is_connected_to_vpn" "is_connected_to_vpn desc" "last_vpn_event" "last_vpn_event desc" "is_locked_until__date" "is_locked_until__date desc" "logs_channel" "logs_channel desc" "public_address" "public_address desc" "vpn_address" "vpn_address desc" "ip_address" "ip_address desc" "mac_address" "mac_address desc" "memory_usage" "memory_usage desc" "memory_total" "memory_total desc" "storage_block_device" "storage_block_device desc" "storage_usage" "storage_usage desc" "storage_total" "storage_total desc" "cpu_usage" "cpu_usage desc" "cpu_temp" "cpu_temp desc" "is_undervolted" "is_undervolted desc" "cpu_id" "cpu_id desc" "download_progress" "download_progress desc" "status" "status desc" "os_version" "os_version desc" "os_variant" "os_variant desc" "supervisor_version" "supervisor_version desc" "provisioning_progress" "provisioning_progress desc" "provisioning_state" "provisioning_state desc" "api_port" "api_port desc" "api_secret" "api_secret desc" "is_web_accessible" "is_web_accessible desc" "overall_status" "overall_status desc" "overall_progress" "overall_progress desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to device

Request Body schema: application/json

New entity

required
integer or string <int64>
integer or string <int64>
api_heartbeat_state
string
uuid
string
local_id
string or null
device_name
string or null
note
string or null
is_online
boolean
last_connectivity_event
string or null <date-time>
is_connected_to_vpn
boolean
last_vpn_event
string or null <date-time>
is_locked_until__date
string or null <date-time>
logs_channel
string or null
public_address
string or null
vpn_address
string or null
ip_address
string or null
mac_address
string or null
memory_usage
integer or null <int32>
memory_total
integer or null <int32>
storage_block_device
string or null
storage_usage
integer or null <int32>
storage_total
integer or null <int32>
cpu_usage
integer or null <int32>
cpu_temp
integer or null <int32>
is_undervolted
boolean
cpu_id
string or null
download_progress
integer or null <int32>
status
string or null
os_version
string or null
os_variant
string or null
supervisor_version
string or null
provisioning_progress
integer or null <int32>
provisioning_state
string or null
api_port
integer or null <int32>
api_secret
string or null
is_web_accessible
boolean or null
overall_status
string or null
overall_progress
integer or null <int32>
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

Get entity from device by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

Update entity in device

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

integer or string <int64>
api_heartbeat_state
string
uuid
string
local_id
string or null
device_name
string or null
note
string or null
is_online
boolean
last_connectivity_event
string or null <date-time>
is_connected_to_vpn
boolean
last_vpn_event
string or null <date-time>
is_locked_until__date
string or null <date-time>
logs_channel
string or null
public_address
string or null
vpn_address
string or null
ip_address
string or null
mac_address
string or null
memory_usage
integer or null <int32>
memory_total
integer or null <int32>
storage_block_device
string or null
storage_usage
integer or null <int32>
storage_total
integer or null <int32>
cpu_usage
integer or null <int32>
cpu_temp
integer or null <int32>
is_undervolted
boolean
cpu_id
string or null
download_progress
integer or null <int32>
status
string or null
os_version
string or null
os_variant
string or null
supervisor_version
string or null
provisioning_progress
integer or null <int32>
provisioning_state
string or null
api_port
integer or null <int32>
api_secret
string or null
is_web_accessible
boolean or null
overall_status
string or null
overall_progress
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from device

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related is_of__device_type

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name" "logo" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__cpu_architecture" "belongs_to__device_family"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string",
  • "name": "string",
  • "logo": "string",
  • "contract": "string",
  • "is_of__cpu_architecture": {
    },
  • "belongs_to__device_family": {
    }
}

Get related belongs_to__application

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

Get related is_running__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

Get related is_managed_by__service_instance

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "service_type" "ip_address" "last_heartbeat"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "service_type": "string",
  • "ip_address": "string",
  • "last_heartbeat": "2017-04-13T15:51:04Z"
}

Get related should_be_running__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

Get related should_be_operated_by__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

Get related is_managed_by__device

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

Get related should_be_managed_by__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

device_config_variable

Get entities from device_config_variable

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "name" "name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to device_config_variable

Request Body schema: application/json

New entity

name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "device": {
    }
}

Get entity from device_config_variable by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "device": {
    }
}

Update entity in device_config_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from device_config_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related device

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

device_environment_variable

Get entities from device_environment_variable

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "name" "name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to device_environment_variable

Request Body schema: application/json

New entity

name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "device": {
    }
}

Get entity from device_environment_variable by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "device": {
    }
}

Update entity in device_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from device_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related device

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

device_family

Get entities from device_family

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "slug" "slug desc" "name" "name desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_manufactured_by__device_manufacturer"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from device_family by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_manufactured_by__device_manufacturer"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string",
  • "name": "string",
  • "is_manufactured_by__device_manufacturer": {
    }
}

Get related is_manufactured_by__device_manufacturer

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string",
  • "name": "string"
}

device_manufacturer

Get entities from device_manufacturer

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "slug" "slug desc" "name" "name desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from device_manufacturer by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string",
  • "name": "string"
}

device_service_environment_variable

Get entities from device_service_environment_variable

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "name" "name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "service_install"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to device_service_environment_variable

Request Body schema: application/json

New entity

name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "service_install": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "service_install": {
    }
}

Get entity from device_service_environment_variable by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "service_install"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "service_install": {
    }
}

Update entity in device_service_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from device_service_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related service_install

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device" "installs__service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "device": {
    },
  • "installs__service": {
    }
}

device_tag

Get entities from device_tag

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "tag_key" "tag_key desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "tag_key" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to device_tag

Request Body schema: application/json

New entity

tag_key
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "tag_key": "string",
  • "id": "42",
  • "value": "string",
  • "device": {
    }
}

Get entity from device_tag by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "tag_key" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "tag_key": "string",
  • "id": "42",
  • "value": "string",
  • "device": {
    }
}

Update entity in device_tag

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

tag_key
string
value
string

Responses

Request samples

Content type
application/json
{
  • "tag_key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from device_tag

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related device

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

device_type

Get entities from device_type

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "slug" "slug desc" "name" "name desc" "logo" "logo desc" "contract" "contract desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name" "logo" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__cpu_architecture" "belongs_to__device_family"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from device_type by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name" "logo" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__cpu_architecture" "belongs_to__device_family"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string",
  • "name": "string",
  • "logo": "string",
  • "contract": "string",
  • "is_of__cpu_architecture": {
    },
  • "belongs_to__device_family": {
    }
}

Get related is_of__cpu_architecture

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string"
}

Get related belongs_to__device_family

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_manufactured_by__device_manufacturer"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string",
  • "name": "string",
  • "is_manufactured_by__device_manufacturer": {
    }
}

device_type_alias

Get entities from device_type_alias

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "is_referenced_by__alias" "is_referenced_by__alias desc" "id" "id desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "is_referenced_by__alias" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from device_type_alias by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "is_referenced_by__alias" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "is_referenced_by__alias": "string",
  • "id": "42",
  • "device_type": {
    }
}

Get related device_type

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "slug" "name" "logo" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__cpu_architecture" "belongs_to__device_family"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "slug": "string",
  • "name": "string",
  • "logo": "string",
  • "contract": "string",
  • "is_of__cpu_architecture": {
    },
  • "belongs_to__device_family": {
    }
}

gateway_download

Get entities from gateway_download

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "status" "status desc" "download_progress" "download_progress desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "status" "download_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "image" "is_downloaded_by__device"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to gateway_download

Request Body schema: application/json

New entity

required
integer or string <int64>
status
string
download_progress
integer or null <int32>
object (entityReference)
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "status": "string",
  • "download_progress": 0,
  • "image": {
    },
  • "is_downloaded_by__device": {
    }
}

Get entity from gateway_download by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "status" "download_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "image" "is_downloaded_by__device"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "status": "string",
  • "download_progress": 0,
  • "image": {
    },
  • "is_downloaded_by__device": {
    }
}

Update entity in gateway_download

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

status
string
download_progress
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "download_progress": 0
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from gateway_download

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related image

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "start_timestamp" "end_timestamp" "dockerfile" "image_size" "is_stored_at__image_location" "project_type" "error_message" "build_log" "push_timestamp" "status" "content_hash" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_a_build_of__service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "dockerfile": "string",
  • "image_size": "42",
  • "is_stored_at__image_location": "string",
  • "project_type": "string",
  • "error_message": "string",
  • "build_log": "string",
  • "push_timestamp": "2017-04-13T15:51:04Z",
  • "status": "string",
  • "content_hash": "string",
  • "contract": "string",
  • "is_a_build_of__service": {
    }
}

Get related is_downloaded_by__device

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

image

Get entities from image

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "start_timestamp" "start_timestamp desc" "end_timestamp" "end_timestamp desc" "dockerfile" "dockerfile desc" "image_size" "image_size desc" "is_stored_at__image_location" "is_stored_at__image_location desc" "project_type" "project_type desc" "error_message" "error_message desc" "build_log" "build_log desc" "push_timestamp" "push_timestamp desc" "status" "status desc" "content_hash" "content_hash desc" "contract" "contract desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "start_timestamp" "end_timestamp" "dockerfile" "image_size" "is_stored_at__image_location" "project_type" "error_message" "build_log" "push_timestamp" "status" "content_hash" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_a_build_of__service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to image

Request Body schema: application/json

New entity

required
integer or string <int64>
start_timestamp
string <date-time>
end_timestamp
string or null <date-time>
dockerfile
string or null
(integer or null) or (string or null) <int64>
is_stored_at__image_location
string
project_type
string or null
error_message
string or null
build_log
string or null
push_timestamp
string or null <date-time>
status
string
content_hash
string or null
contract
string or null
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "id": "42",
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "dockerfile": "string",
  • "image_size": "42",
  • "is_stored_at__image_location": "string",
  • "project_type": "string",
  • "error_message": "string",
  • "build_log": "string",
  • "push_timestamp": "2017-04-13T15:51:04Z",
  • "status": "string",
  • "content_hash": "string",
  • "contract": "string",
  • "is_a_build_of__service": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "dockerfile": "string",
  • "image_size": "42",
  • "is_stored_at__image_location": "string",
  • "project_type": "string",
  • "error_message": "string",
  • "build_log": "string",
  • "push_timestamp": "2017-04-13T15:51:04Z",
  • "status": "string",
  • "content_hash": "string",
  • "contract": "string",
  • "is_a_build_of__service": {
    }
}

Get entity from image by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "start_timestamp" "end_timestamp" "dockerfile" "image_size" "is_stored_at__image_location" "project_type" "error_message" "build_log" "push_timestamp" "status" "content_hash" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_a_build_of__service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "dockerfile": "string",
  • "image_size": "42",
  • "is_stored_at__image_location": "string",
  • "project_type": "string",
  • "error_message": "string",
  • "build_log": "string",
  • "push_timestamp": "2017-04-13T15:51:04Z",
  • "status": "string",
  • "content_hash": "string",
  • "contract": "string",
  • "is_a_build_of__service": {
    }
}

Update entity in image

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

start_timestamp
string <date-time>
end_timestamp
string or null <date-time>
dockerfile
string or null
(integer or null) or (string or null) <int64>
is_stored_at__image_location
string
project_type
string or null
error_message
string or null
build_log
string or null
push_timestamp
string or null <date-time>
status
string
content_hash
string or null
contract
string or null

Responses

Request samples

Content type
application/json
{
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "dockerfile": "string",
  • "image_size": "42",
  • "is_stored_at__image_location": "string",
  • "project_type": "string",
  • "error_message": "string",
  • "build_log": "string",
  • "push_timestamp": "2017-04-13T15:51:04Z",
  • "status": "string",
  • "content_hash": "string",
  • "contract": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from image

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related is_a_build_of__service

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "service_name" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "service_name": "string",
  • "id": "42",
  • "application": {
    }
}

image__is_part_of__release

Get entities from image__is_part_of__release

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "image" "is_part_of__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to image__is_part_of__release

Request Body schema: application/json

New entity

required
integer or string <int64>
object (entityReference)
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "image": {
    },
  • "is_part_of__release": {
    }
}

Get entity from image__is_part_of__release by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "image" "is_part_of__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "image": {
    },
  • "is_part_of__release": {
    }
}

Update entity in image__is_part_of__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

object (image__is_part_of__release (for update))

{"x-ref-scheme": ["undefined"]}

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from image__is_part_of__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related image

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "start_timestamp" "end_timestamp" "dockerfile" "image_size" "is_stored_at__image_location" "project_type" "error_message" "build_log" "push_timestamp" "status" "content_hash" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_a_build_of__service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "dockerfile": "string",
  • "image_size": "42",
  • "is_stored_at__image_location": "string",
  • "project_type": "string",
  • "error_message": "string",
  • "build_log": "string",
  • "push_timestamp": "2017-04-13T15:51:04Z",
  • "status": "string",
  • "content_hash": "string",
  • "contract": "string",
  • "is_a_build_of__service": {
    }
}

Get related is_part_of__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

image_environment_variable

Get entities from image_environment_variable

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "name" "name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "release_image"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to image_environment_variable

Request Body schema: application/json

New entity

name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "release_image": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "release_image": {
    }
}

Get entity from image_environment_variable by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "release_image"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "release_image": {
    }
}

Update entity in image_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from image_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related release_image

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "image" "is_part_of__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "image": {
    },
  • "is_part_of__release": {
    }
}

image_install

Get entities from image_install

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "install_date" "install_date desc" "download_progress" "download_progress desc" "status" "status desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "install_date" "download_progress" "status"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device" "installs__image" "is_provided_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to image_install

Request Body schema: application/json

New entity

required
integer or string <int64>
install_date
string <date-time>
download_progress
integer or null <int32>
status
string
object (entityReference)
object (entityReference)
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "install_date": "2017-04-13T15:51:04Z",
  • "download_progress": 0,
  • "status": "string",
  • "device": {
    },
  • "installs__image": {
    },
  • "is_provided_by__release": {
    }
}

Get entity from image_install by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "install_date" "download_progress" "status"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device" "installs__image" "is_provided_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "install_date": "2017-04-13T15:51:04Z",
  • "download_progress": 0,
  • "status": "string",
  • "device": {
    },
  • "installs__image": {
    },
  • "is_provided_by__release": {
    }
}

Update entity in image_install

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

install_date
string <date-time>
download_progress
integer or null <int32>
status
string

Responses

Request samples

Content type
application/json
{
  • "install_date": "2017-04-13T15:51:04Z",
  • "download_progress": 0,
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from image_install

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related device

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

Get related installs__image

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "start_timestamp" "end_timestamp" "dockerfile" "image_size" "is_stored_at__image_location" "project_type" "error_message" "build_log" "push_timestamp" "status" "content_hash" "contract"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_a_build_of__service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "dockerfile": "string",
  • "image_size": "42",
  • "is_stored_at__image_location": "string",
  • "project_type": "string",
  • "error_message": "string",
  • "build_log": "string",
  • "push_timestamp": "2017-04-13T15:51:04Z",
  • "status": "string",
  • "content_hash": "string",
  • "contract": "string",
  • "is_a_build_of__service": {
    }
}

Get related is_provided_by__release

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

image_label

Get entities from image_label

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "label_name" "label_name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "label_name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "release_image"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to image_label

Request Body schema: application/json

New entity

label_name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "label_name": "string",
  • "id": "42",
  • "value": "string",
  • "release_image": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "label_name": "string",
  • "id": "42",
  • "value": "string",
  • "release_image": {
    }
}

Get entity from image_label by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "label_name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "release_image"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "label_name": "string",
  • "id": "42",
  • "value": "string",
  • "release_image": {
    }
}

Update entity in image_label

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

label_name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "label_name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from image_label

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related release_image

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "image" "is_part_of__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "image": {
    },
  • "is_part_of__release": {
    }
}

organization

Get entities from organization

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "name" "name desc" "handle" "handle desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "name" "handle"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from organization by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "name" "handle"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "name": "string",
  • "handle": "string"
}

organization_membership

Get entities from organization_membership

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "user" "is_member_of__organization"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from organization_membership by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "user" "is_member_of__organization"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "user": {
    },
  • "is_member_of__organization": {
    }
}

Get related user

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "username" "password" "jwt_secret" "email"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "username": "string",
  • "password": "string",
  • "jwt_secret": "string",
  • "email": "string"
}

Get related is_member_of__organization

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "name" "handle"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "name": "string",
  • "handle": "string"
}

release

Get entities from release

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "commit" "commit desc" "composition" "composition desc" "status" "status desc" "source" "source desc" "build_log" "build_log desc" "is_invalidated" "is_invalidated desc" "start_timestamp" "start_timestamp desc" "end_timestamp" "end_timestamp desc" "update_timestamp" "update_timestamp desc" "release_version" "release_version desc" "contract" "contract desc" "is_passing_tests" "is_passing_tests desc" "is_finalized_at__date" "is_finalized_at__date desc" "phase" "phase desc" "semver_major" "semver_major desc" "semver_minor" "semver_minor desc" "semver_patch" "semver_patch desc" "semver_prerelease" "semver_prerelease desc" "semver_build" "semver_build desc" "variant" "variant desc" "revision" "revision desc" "known_issue_list" "known_issue_list desc" "note" "note desc" "invalidation_reason" "invalidation_reason desc" "is_final" "is_final desc" "semver" "semver desc" "raw_version" "raw_version desc" "version" "version desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to release

Request Body schema: application/json

New entity

required
integer or string <int64>
commit
string
composition
string
status
string
source
string
build_log
string or null
is_invalidated
boolean
start_timestamp
string <date-time>
end_timestamp
string or null <date-time>
update_timestamp
string <date-time>
release_version
string or null
contract
string or null
is_passing_tests
boolean
is_finalized_at__date
string or null <date-time>
phase
string or null
semver_major
integer <int32>
semver_minor
integer <int32>
semver_patch
integer <int32>
semver_prerelease
string
semver_build
string
variant
string
revision
integer or null <int32>
known_issue_list
string or null
note
string or null
invalidation_reason
string or null
is_final
boolean
semver
string
raw_version
string
version
string
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

Get entity from release by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

Update entity in release

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

commit
string
composition
string
status
string
source
string
build_log
string or null
is_invalidated
boolean
start_timestamp
string <date-time>
end_timestamp
string or null <date-time>
update_timestamp
string <date-time>
release_version
string or null
contract
string or null
is_passing_tests
boolean
is_finalized_at__date
string or null <date-time>
phase
string or null
semver_major
integer <int32>
semver_minor
integer <int32>
semver_patch
integer <int32>
semver_prerelease
string
semver_build
string
variant
string
revision
integer or null <int32>
known_issue_list
string or null
note
string or null
invalidation_reason
string or null
is_final
boolean
semver
string
raw_version
string
version
string

Responses

Request samples

Content type
application/json
{
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from release

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related belongs_to__application

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

release_tag

Get entities from release_tag

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "tag_key" "tag_key desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "tag_key" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to release_tag

Request Body schema: application/json

New entity

tag_key
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "tag_key": "string",
  • "id": "42",
  • "value": "string",
  • "release": {
    }
}

Get entity from release_tag by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "tag_key" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "tag_key": "string",
  • "id": "42",
  • "value": "string",
  • "release": {
    }
}

Update entity in release_tag

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

tag_key
string
value
string

Responses

Request samples

Content type
application/json
{
  • "tag_key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from release_tag

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related release

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "commit" "composition" "status" "source" "build_log" "is_invalidated" "start_timestamp" "end_timestamp" "update_timestamp" "release_version" "contract" "is_passing_tests" "is_finalized_at__date" "phase" "semver_major" "semver_minor" "semver_patch" "semver_prerelease" "semver_build" "variant" "revision" "known_issue_list" "note" "invalidation_reason" "is_final" "semver" "raw_version" "version"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "belongs_to__application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "commit": "string",
  • "composition": "string",
  • "status": "string",
  • "source": "string",
  • "build_log": "string",
  • "is_invalidated": true,
  • "start_timestamp": "2017-04-13T15:51:04Z",
  • "end_timestamp": "2017-04-13T15:51:04Z",
  • "update_timestamp": "2017-04-13T15:51:04Z",
  • "release_version": "string",
  • "contract": "string",
  • "is_passing_tests": true,
  • "is_finalized_at__date": "2017-04-13T15:51:04Z",
  • "phase": "string",
  • "semver_major": 0,
  • "semver_minor": 0,
  • "semver_patch": 0,
  • "semver_prerelease": "string",
  • "semver_build": "string",
  • "variant": "string",
  • "revision": 0,
  • "known_issue_list": "string",
  • "note": "string",
  • "invalidation_reason": "string",
  • "is_final": true,
  • "semver": "string",
  • "raw_version": "string",
  • "version": "string",
  • "belongs_to__application": {
    }
}

service

Get entities from service

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "service_name" "service_name desc" "id" "id desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "service_name" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to service

Request Body schema: application/json

New entity

service_name
string
required
integer or string <int64>
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "service_name": "string",
  • "id": "42",
  • "application": {
    }
}

Get entity from service by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "service_name" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "service_name": "string",
  • "id": "42",
  • "application": {
    }
}

Update entity in service

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

service_name
string

Responses

Request samples

Content type
application/json
{
  • "service_name": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from service

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related application

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "should_track_latest_release" "is_of__class" "app_name" "slug" "is_host" "is_archived" "uuid" "is_public"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "organization" "is_for__device_type" "should_be_running__release" "depends_on__application" "application_type"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "should_track_latest_release": true,
  • "is_of__class": "string",
  • "app_name": "string",
  • "slug": "string",
  • "is_host": true,
  • "is_archived": true,
  • "uuid": "string",
  • "is_public": true,
  • "organization": {
    },
  • "is_for__device_type": {
    },
  • "should_be_running__release": {
    },
  • "depends_on__application": { },
  • "application_type": {
    }
}

service_environment_variable

Get entities from service_environment_variable

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "name" "name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to service_environment_variable

Request Body schema: application/json

New entity

name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "service": {
    }
}

Get entity from service_environment_variable by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "name": "string",
  • "id": "42",
  • "value": "string",
  • "service": {
    }
}

Update entity in service_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from service_environment_variable

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related service

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "service_name" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "service_name": "string",
  • "id": "42",
  • "application": {
    }
}

service_install

Get entities from service_install

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device" "installs__service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to service_install

Request Body schema: application/json

New entity

required
integer or string <int64>
object (entityReference)
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "device": {
    },
  • "installs__service": {
    }
}

Get entity from service_install by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "device" "installs__service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "device": {
    },
  • "installs__service": {
    }
}

Update entity in service_install

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

object (service_install (for update))

{"x-ref-scheme": ["undefined"]}

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from service_install

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related device

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "api_heartbeat_state" "uuid" "local_id" "device_name" "note" "is_online" "last_connectivity_event" "is_connected_to_vpn" "last_vpn_event" "is_locked_until__date" "logs_channel" "public_address" "vpn_address" "ip_address" "mac_address" "memory_usage" "memory_total" "storage_block_device" "storage_usage" "storage_total" "cpu_usage" "cpu_temp" "is_undervolted" "cpu_id" "download_progress" "status" "os_version" "os_variant" "supervisor_version" "provisioning_progress" "provisioning_state" "api_port" "api_secret" "is_web_accessible" "overall_status" "overall_progress"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "is_of__device_type" "belongs_to__application" "is_running__release" "is_managed_by__service_instance" "should_be_running__release" "should_be_operated_by__release" "is_managed_by__device" "should_be_managed_by__release"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "api_heartbeat_state": "string",
  • "uuid": "string",
  • "local_id": "string",
  • "device_name": "string",
  • "note": "string",
  • "is_online": true,
  • "last_connectivity_event": "2017-04-13T15:51:04Z",
  • "is_connected_to_vpn": true,
  • "last_vpn_event": "2017-04-13T15:51:04Z",
  • "is_locked_until__date": "2017-04-13T15:51:04Z",
  • "logs_channel": "string",
  • "public_address": "string",
  • "vpn_address": "string",
  • "ip_address": "string",
  • "mac_address": "string",
  • "memory_usage": 0,
  • "memory_total": 0,
  • "storage_block_device": "string",
  • "storage_usage": 0,
  • "storage_total": 0,
  • "cpu_usage": 0,
  • "cpu_temp": 0,
  • "is_undervolted": true,
  • "cpu_id": "string",
  • "download_progress": 0,
  • "status": "string",
  • "os_version": "string",
  • "os_variant": "string",
  • "supervisor_version": "string",
  • "provisioning_progress": 0,
  • "provisioning_state": "string",
  • "api_port": 0,
  • "api_secret": "string",
  • "is_web_accessible": true,
  • "overall_status": "string",
  • "overall_progress": 0,
  • "is_of__device_type": {
    },
  • "belongs_to__application": {
    },
  • "is_running__release": {
    },
  • "is_managed_by__service_instance": {
    },
  • "should_be_running__release": {
    },
  • "should_be_operated_by__release": {
    },
  • "is_managed_by__device": { },
  • "should_be_managed_by__release": {
    }
}

Get related installs__service

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "service_name" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "service_name": "string",
  • "id": "42",
  • "application": {
    }
}

service_instance

Get entities from service_instance

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "service_type" "service_type desc" "ip_address" "ip_address desc" "last_heartbeat" "last_heartbeat desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "service_type" "ip_address" "last_heartbeat"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from service_instance by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "service_type" "ip_address" "last_heartbeat"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "service_type": "string",
  • "ip_address": "string",
  • "last_heartbeat": "2017-04-13T15:51:04Z"
}

service_label

Get entities from service_label

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "label_name" "label_name desc" "id" "id desc" "value" "value desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "label_name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to service_label

Request Body schema: application/json

New entity

label_name
string
required
integer or string <int64>
value
string
object (entityReference)

Responses

Request samples

Content type
application/json
{
  • "label_name": "string",
  • "id": "42",
  • "value": "string",
  • "service": {}
}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "label_name": "string",
  • "id": "42",
  • "value": "string",
  • "service": {
    }
}

Get entity from service_label by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "label_name" "id" "value"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "service"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "label_name": "string",
  • "id": "42",
  • "value": "string",
  • "service": {
    }
}

Update entity in service_label

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

label_name
string
value
string

Responses

Request samples

Content type
application/json
{
  • "label_name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from service_label

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related service

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "service_name" "id"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "application"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "service_name": "string",
  • "id": "42",
  • "application": {
    }
}

user

Get entities from user

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "id" "id desc" "actor" "actor desc" "username" "username desc" "password" "password desc" "jwt_secret" "jwt_secret desc" "email" "email desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "username" "password" "jwt_secret" "email"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Get entity from user by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "username" "password" "jwt_secret" "email"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "username": "string",
  • "password": "string",
  • "jwt_secret": "string",
  • "email": "string"
}

user__has__public_key

Get entities from user__has__public_key

query Parameters
top
integer >= 0
Example: top=50

Show only the first n items, see Paging - Top

skip
integer >= 0

Skip the first n items, see Paging - Skip

search
string

Search items by search phrases, see Searching

filter
string

Filter items by property values, see Filtering

count
boolean

Include count of items, see Count

orderby
Array of strings unique
Items Enum: "created_at" "created_at desc" "modified_at" "modified_at desc" "public_key" "public_key desc" "id" "id desc" "title" "title desc"

Order items by property values, see Sorting

select
Array of strings unique
Items Enum: "created_at" "modified_at" "public_key" "id" "title"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "user"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "@count": 0,
  • "d": [
    ]
}

Add new entity to user__has__public_key

Request Body schema: application/json

New entity

public_key
string
required
integer or string <int64>
title
string
object (entityReference)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "public_key": "string",
  • "id": "42",
  • "title": "string",
  • "user": {
    }
}

Get entity from user__has__public_key by key

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "public_key" "id" "title"

Select properties to be returned, see Select

expand
Array of strings unique
Items Enum: "*" "user"

Expand related entities, see Expand

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "public_key": "string",
  • "id": "42",
  • "title": "string",
  • "user": {
    }
}

Update entity in user__has__public_key

path Parameters
required
integer or string <int64>
Example: 42

key: id

Request Body schema: application/json

New property values

public_key
string
title
string

Responses

Request samples

Content type
application/json
{
  • "public_key": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete entity from user__has__public_key

path Parameters
required
integer or string <int64>
Example: 42

key: id

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get related user

path Parameters
required
integer or string <int64>
Example: 42

key: id

query Parameters
select
Array of strings unique
Items Enum: "created_at" "modified_at" "id" "actor" "username" "password" "jwt_secret" "email"

Select properties to be returned, see Select

Responses

Response samples

Content type
application/json
{
  • "created_at": "2017-04-13T15:51:04Z",
  • "modified_at": "2017-04-13T15:51:04Z",
  • "id": "42",
  • "actor": "42",
  • "username": "string",
  • "password": "string",
  • "jwt_secret": "string",
  • "email": "string"
}